Skip to content

docs(linux): Add initial documentation for BeagleBadge #602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
jmenti wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(linux): Add initial documentation for BeagleBadge #602

jmenti wants to merge 1 commit into from
+191 −1

Conversation

@jmenti
Copy link
Collaborator

@jmenti jmenti commented Dec 18, 2025 •
edited
Loading

Add an initial 'How to guide' for BeagleBadge board supported in Armbian in Arago distributions.

@github-actions
Copy link

github-actions bot commented Dec 18, 2025

New warnings found with rstcheck:

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst:3: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)

@jmenti jmenti force-pushed the beaglebadge-initial-docs branch from 1bb0711 to 758fc3d Compare December 18, 2025 21:44
StaticRocket
StaticRocket requested changes Dec 18, 2025
View reviewed changes
Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please review the vale warnings as well

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst
Copy link
Member

@StaticRocket StaticRocket Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use the standard section hierarchy.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections

Copy link
Member

@StaticRocket StaticRocket Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is still valid

Copy link

@jmende27 jmende27 Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WYM, headers are already fixed. *** for chapters, ==== for sections, and ---- for subsections. Am I missing something here?

Copy link
Member

@StaticRocket StaticRocket Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Every file is parsed from ordinal 0, so it should actually be like the following:
https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#headings--sections

Copy link
Member

@StaticRocket StaticRocket Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now Judith, that change needs to be propagated to all the other sections...

praneethbajjuri
praneethbajjuri previously approved these changes Dec 18, 2025
View reviewed changes
Copy link
Collaborator

@praneethbajjuri praneethbajjuri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok for initial docs.
@Grippy98 please review. We can always expand this more based on incremental feedback later

@jmenti jmenti force-pushed the beaglebadge-initial-docs branch from 758fc3d to 3ccd503 Compare December 18, 2025 23:30
@StaticRocket
Copy link
Member

StaticRocket commented Dec 19, 2025

also, https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#commit-types

@jmenti jmenti force-pushed the beaglebadge-initial-docs branch 2 times, most recently from aefb06c to 438f8ef Compare December 19, 2025 16:34
StaticRocket
StaticRocket requested changes Dec 19, 2025
View reviewed changes
Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two suggestions to make vale happy. Please also fix the sections.

jonaswood01
jonaswood01 reviewed Dec 19, 2025
View reviewed changes
@praneethbajjuri praneethbajjuri self-requested a review December 19, 2025 21:02
@jmenti jmenti force-pushed the beaglebadge-initial-docs branch from 438f8ef to 336fdda Compare January 5, 2026 18:59
@jmende27
Copy link

jmende27 commented Jan 5, 2026

all comments, have been adressed in update, @StaticRocket @glneo @jonaswood01 please review

jonaswood01
jonaswood01 reviewed Jan 5, 2026
View reviewed changes
jonaswood01
jonaswood01 reviewed Jan 5, 2026
View reviewed changes
jonaswood01
jonaswood01 reviewed Jan 5, 2026
View reviewed changes
@jmenti jmenti force-pushed the beaglebadge-initial-docs branch from 336fdda to 61d7c47 Compare January 5, 2026 22:49
jonaswood01
jonaswood01 approved these changes Jan 5, 2026
View reviewed changes
Copy link
Contributor

@jonaswood01 jonaswood01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it won't let me resolve my comments for some reason, but approved on my end pending #602 (comment) (my last comment)

@jmenti jmenti force-pushed the beaglebadge-initial-docs branch from 61d7c47 to 1671f3e Compare January 5, 2026 23:01
StaticRocket
StaticRocket reviewed Jan 6, 2026
View reviewed changes
@jmenti jmenti force-pushed the beaglebadge-initial-docs branch from 1671f3e to 0433b5a Compare January 6, 2026 23:55
@jmenti
feat(linux): Add initial documentation for BeagleBadge
b732c4f 
Add an initial 'How to guide' for BeagleBadge board supported
on Debian in Arago distributions.

Signed-off-by: Judith Mendez <[email protected]>
@jmenti jmenti force-pushed the beaglebadge-initial-docs branch from 0433b5a to b732c4f Compare January 8, 2026 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StaticRocket StaticRocket StaticRocket requested changes

@cshilwant cshilwant Awaiting requested review from cshilwant cshilwant is a code owner

@uditkumarti uditkumarti Awaiting requested review from uditkumarti uditkumarti is a code owner

@gehariprasath gehariprasath Awaiting requested review from gehariprasath gehariprasath is a code owner

@VeeruPrudhvi VeeruPrudhvi Awaiting requested review from VeeruPrudhvi VeeruPrudhvi is a code owner

@jeevantelukula jeevantelukula Awaiting requested review from jeevantelukula jeevantelukula is a code owner

@praneethbajjuri praneethbajjuri Awaiting requested review from praneethbajjuri praneethbajjuri is a code owner

+3 more reviewers

@jonaswood01 jonaswood01 jonaswood01 approved these changes

@jmende27 jmende27 jmende27 left review comments

@glneo glneo glneo approved these changes

Reviewers whose approvals may not affect merge requirements

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@jmenti @StaticRocket @jmende27 @praneethbajjuri @glneo @jonaswood01